JxBrowser/com.teamdev.jxbrowser.engine/[jvm]EngineOptions

EngineOptions

class EngineOptions

The options that are used to configure Engine instances.

Types

A builder class to construct engine options.

Functions

open fun chromiumDir(): Path

Returns an absolute path to the directory where Chromium binaries are located or the empty string if it was not set.

open fun diskCacheSize(): Optional<Long>

Returns an Optional that contains the disk cache size in bytes or an empty


Optional

if the disk cache size was not set.

open fun googleApiKey(): Optional<String>

Returns an Optional that contains a string representing the Google API key or an empty Optional if the Google API key was not set.

googleDefaultClientId

open fun googleDefaultClientId(): Optional<String>

Returns an Optional that contains a string representing the Google client ID or an empty Optional if the Google client ID was not set.

googleDefaultClientSecret

open fun googleDefaultClientSecret(): Optional<String>

Returns an Optional that contains a string representing the Google client secret or an empty Optional if the Google client secret was not set.

isAutoplayEnabled

open fun isAutoplayEnabled(): Boolean

Indicates whether video playback will automatically start after page loading.

isChromiumTrafficDisabled

open fun isChromiumTrafficDisabled(): Boolean

Indicates whether Chromium services that cause additional traffic are disabled.

isDnsQuickCheckDisabled

open fun isDnsQuickCheckDisabled(): Boolean

Indicates whether DNS Quick Check is disabled in proxy resolution.

isFileAccessFromFilesAllowed

open fun isFileAccessFromFilesAllowed(): Boolean

Indicates whether file access from files is allowed.

open fun isGpuDisabled(): Boolean

Indicates whether GPU is disabled.

isIncognitoEnabled

open fun isIncognitoEnabled(): Boolean

Indicates whether the default profile of the Engine instance is incognito.

isMediaRoutingEnabled

open fun isMediaRoutingEnabled(): Boolean

Indicates whether media routing is enabled for the Engine instance.

isProprietaryFeatureEnabled

open fun isProprietaryFeatureEnabled(feature: ProprietaryFeature): Boolean

Indicates whether the given proprietary feature is enabled.

isSandboxDisabled

open fun isSandboxDisabled(): Boolean

Indicates whether the sandbox is disabled.

isTouchMenuDisabled

open fun isTouchMenuDisabled(): Boolean

Indicates whether touch popup menu is disabled.

isWebSecurityDisabled

open fun isWebSecurityDisabled(): Boolean

Indicates whether the same-origin policy is disabled.

open fun language(): Language

Returns the Chromium language that is used on the default error pages and message dialogs.

open fun licenseKey(): Optional<String>

Returns an Optional that contains a string representing the license key or an empty Optional if the license key was not set.

open fun newBuilder(renderingMode: RenderingMode): EngineOptions.Builder

Creates a new EngineOptions builder.

open fun passwordStore(): Optional<PasswordStore>

Returns an Optional that contains the password store type or an empty


Optional

if the password store type was not set.

proprietaryFeatures

open fun proprietaryFeatures(): Set<ProprietaryFeature>

Returns a set of enabled proprietary features.

remoteDebuggingPort

open fun remoteDebuggingPort(): Optional<Integer>

Returns an Optional that contains the number representing the remote debugging port or an empty Optional if the remote debugging port was not set.

rendererHangTimeout

open fun rendererHangTimeout(): Duration

Returns how many seconds JavaScript can block the page before it is considered hanged.

open fun renderingMode(): RenderingMode

Returns the rendering mode indicating how the content of the web pages will be rendered.

open fun schemes(): Map<Scheme, InterceptUrlRequestCallback>

Returns an immutable map of the schemes that will be intercepted.

secureOriginWhiteList

open fun secureOriginWhiteList(): List<String>

Returns an immutable list of the insecure origins that will be treated as secure.

open fun switches(): List<String>

Returns an immutable list of the Chromium switches that will be passed to the Chromium Main process.

open fun userAgent(): Optional<String>

Returns an Optional that contains a string that is used to override the default user agent or an empty Optional if the custom user agent string was not set.

open fun userDataDir(): Path

Returns an absolute path to the directory where the user data is stored.